/*
 * Tencent is pleased to support the open source community by making BK-JOB蓝鲸智云作业平台 available.
 *
 * Copyright (C) 2021 THL A29 Limited, a Tencent company.  All rights reserved.
 *
 * BK-JOB蓝鲸智云作业平台 is licensed under the MIT License.
 *
 * License for BK-JOB蓝鲸智云作业平台:
 * --------------------------------------------------------------------
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
 * documentation files (the "Software"), to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and
 * to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies or substantial portions of
 * the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
 * THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
 * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 */

package com.tencent.bk.job.common.paas.user;


import com.tencent.bk.job.common.model.dto.BkUserDTO;
import com.tencent.bk.job.common.paas.model.EsbNotifyChannelDTO;

import java.io.IOException;
import java.util.List;
import java.util.Set;

/**
 * Paas客户端
 */
public interface IPaasClient {

    /**
     * 重置当天的统计数据
     */
    void resetTodayStatistics();
    /**
     * 获取用户列表
     *
     * @param fields
     * @param lookupField
     * @param exactLookups
     * @param fuzzyLookups
     * @param page
     * @param pageSize
     * @param noPage
     * @param bkToken
     * @param uin
     * @return
     */
    List<BkUserDTO> getUserList(String fields, String lookupField,
                                String exactLookups, String fuzzyLookups,
                                long page, long pageSize, boolean noPage,
                                String bkToken, String uin);


    /**
     * 获取消息通知渠道
     *
     * @param uin 用户
     * @return
     * @throws IOException
     */
    List<EsbNotifyChannelDTO> getNotifyChannelList(String uin);

    /**
     * ESB发通知信息接口
     *
     * @param msgType
     * @param sender
     * @param receiverList
     * @param title
     * @param content
     * @return
     * @throws Exception
     */
    Boolean sendMsg(String msgType, String sender, Set<String> receiverList, String title, String content)
        throws Exception;
}
